// 版权所有2012 Go作者。版权所有。
// 此源代码的使用受BSD样式的约束
// 可以在许可证文件中找到的许可证。

package vcs

import (
	"encoding/json"
	"errors"
	"fmt"
	exec "internal/execabs"
	"internal/lazyregexp"
	"internal/singleflight"
	"io/fs"
	"log"
	urlpkg "net/url"
	"os"
	"path/filepath"
	"regexp"
	"strings"
	"sync"

	"cmd/go/internal/base"
	"cmd/go/internal/cfg"
	"cmd/go/internal/search"
	"cmd/go/internal/str"
	"cmd/go/internal/web"

	"golang.org/x/mod/module"
)

// vcsCmd描述了如何使用版本控制系统
// 比如Mercurial、Git或Subversion。
type Cmd struct {
	Name string
	Cmd  string // 要调用命令的二进制文件的名称

	CreateCmd   []string // 用于下载存储库的新副本的命令
	DownloadCmd []string // 将更新下载到现有存储库的命令

	TagCmd         []tagCmd // 用于列出标记的命令
	TagLookupCmd   []tagCmd // 运行tagSyncCmd之前查找标记的命令
	TagSyncCmd     []string // 要同步到特定标记的命令
	TagSyncDefault []string // 要同步到默认标记的命令

	Scheme  []string
	PingCmd string

	RemoteRepo  func(v *Cmd, rootDir string) (remoteRepo string, err error)
	ResolveRepo func(v *Cmd, rootDir, remoteRepo string) (realRepo string, err error)
}

var defaultSecureScheme = map[string]bool{
	"https":   true,
	"git+ssh": true,
	"bzr+ssh": true,
	"svn+ssh": true,
	"ssh":     true,
}

func (v *Cmd) IsSecure(repo string) bool {
	u, err := urlpkg.Parse(repo)
	if err != nil {
		// 如果repo不是URL，那么它就不安全。
		return false
	}
	return v.isSecureScheme(u.Scheme)
}

func (v *Cmd) isSecureScheme(scheme string) bool {
	switch v.Cmd {
	case "git":
		// GIT_ALLOW_协议是GIT定义的环境变量。这是一个
		// 允许与git一起使用的以冒号分隔的方案列表
		// 获取/克隆。任何未提及的方案都将被视为不安全。
		if allow := os.Getenv("GIT_ALLOW_PROTOCOL"); allow != "" {
			for _, s := range strings.Split(allow, ":") {
				if s == scheme {
					return true
				}
			}
			return false
		}
	}
	return defaultSecureScheme[scheme]
}

// tagCmd描述列出可用标记的命令
// 可以传递给tagSyncCmd的。
type tagCmd struct {
	cmd     string // 用于列出标记的命令
	pattern string // regexp从列表中提取标记
}

// vcsList列出了已知的版本控制系统
var vcsList = []*Cmd{
	vcsHg,
	vcsGit,
	vcsSvn,
	vcsBzr,
	vcsFossil,
}

// vcsMod是“mod”方案的存根。这是我寄回来的
// RepootForImportPathDynamic，但在其他方面不被视为VCS命令。
var vcsMod = &Cmd{Name: "mod"}

// vcsByCmd返回给定版本的版本控制系统
// 命令名（hg、git、svn、bzr）。
func vcsByCmd(cmd string) *Cmd {
	for _, vcs := range vcsList {
		if vcs.Cmd == cmd {
			return vcs
		}
	}
	return nil
}

// vcsHg描述了如何使用Mercurial。
var vcsHg = &Cmd{
	Name: "Mercurial",
	Cmd:  "hg",

	CreateCmd:   []string{"clone -U -- {repo} {dir}"},
	DownloadCmd: []string{"pull"},

	// 我们允许标记和分支名称都作为“标记”
	// 用于选择版本。这让人们有了
	// 一个go.release.r60分支和一个go1分支
	// 并在这两方面做出改变，而不是不断地改变
	// 编辑.hgtags。
	TagCmd: []tagCmd{
		{"tags", `^(\S+)`},
		{"branches", `^(\S+)`},
	},
	TagSyncCmd:     []string{"update -r {tag}"},
	TagSyncDefault: []string{"update default"},

	Scheme:     []string{"https", "http", "ssh"},
	PingCmd:    "identify -- {scheme}:// {repo}“，
	RemoteRepo: hgRemoteRepo,
}

func hgRemoteRepo(vcsHg *Cmd, rootDir string) (remoteRepo string, err error) {
	out, err := vcsHg.runOutput(rootDir, "paths default")
	if err != nil {
		return "", err
	}
	return strings.TrimSpace(string(out)), nil
}

// vcsGit描述了如何使用Git。
var vcsGit = &Cmd{
	Name: "Git",
	Cmd:  "git",

	CreateCmd:   []string{"clone -- {repo} {dir}", "-go-internal-cd {dir} submodule update --init --recursive"},
	DownloadCmd: []string{"pull --ff-only", "submodule update --init --recursive"},

	TagCmd: []tagCmd{
		// tags/xxx与名为xxx的git标记匹配
		// origin/xxx匹配默认远程存储库中名为xxx的git分支
		{"show-ref", `(?:tags|origin)/(\S+)$`},
	},
	TagLookupCmd: []tagCmd{
		{"show-ref tags/{tag} origin/{tag}", `((?:tags|origin)/\S+)$`},
	},
	TagSyncCmd: []string{"checkout {tag}", "submodule update --init --recursive"},
	// createCmd和downloadCmd都会更新工作目录。
	// 没有必要在这里做更多。我们以前是“结帐师傅”
	// 但是，如果默认分支未命名为master，则这不起作用。
	// 不要在此处添加“签出主机”。
	// 见golang.org/issue/9032。
	TagSyncDefault: []string{"submodule update --init --recursive"},

	Scheme: []string{"git", "https", "http", "git+ssh", "ssh"},

	// 在ls-remote命令中省略“---”分隔符：git 2.7.4没有
	// 为该命令支持这样的分隔符，并且这种使用应该是安全的
	// 没有它，因为{scheme}值来自上面的预定义列表。
	// 见golang.org/issue/33836。
	PingCmd: "ls-remote {scheme}:// {repo}“，

	RemoteRepo: gitRemoteRepo,
}

// scpSyntaxRe匹配Git用于访问的类似SCP的地址
// 通过SSH访问存储库。
var scpSyntaxRe = lazyregexp.New(`^([a-zA-Z0-9_]+)@([a-zA-Z0-9._-]+):(.*)$`)

func gitRemoteRepo(vcsGit *Cmd, rootDir string) (remoteRepo string, err error) {
	cmd := "config remote.origin.url"
	errParse := errors.New("unable to parse output of git " + cmd)
	errRemoteOriginNotFound := errors.New("remote origin not found")
	outb, err := vcsGit.run1(rootDir, cmd, nil, false)
	if err != nil {
		// 如果未输出任何消息，则表示config参数正确，
		// 但是配置值本身并不存在
		if outb != nil && len(outb) == 0 {
			return "", errRemoteOriginNotFound
		}
		return "", err
	}
	out := strings.TrimSpace(string(outb))

	var repoURL *urlpkg.URL
	if m := scpSyntaxRe.FindStringSubmatch(out); m != nil {
		// 匹配类似于SCP的语法并将其转换为URL。
		// 例如git@github.com：user/repo“变为
		// “ssh:
		repoURL = &urlpkg.URL{
			Scheme: "ssh",
			User:   urlpkg.User(m[1]),
			Host:   m[2],
			Path:   m[3],
		}
	} else {
		repoURL, err = urlpkg.Parse(out)
		if err != nil {
			return "", err
		}
	}

	// 也迭代不安全的方案，因为此函数
	// 报告回购协议的状态。如果我们看不到不安全的方案
	// 我们无法报告实际的回购URL。
	for _, s := range vcsGit.Scheme {
		if repoURL.Scheme == s {
			return repoURL.String(), nil
		}
	}
	return "", errParse
}

// vcsBzr描述了如何使用Bazaar。
var vcsBzr = &Cmd{
	Name: "Bazaar",
	Cmd:  "bzr",

	CreateCmd: []string{"branch -- {repo} {dir}"},

	// 如果没有--覆盖bzr将不会提取已更改的标记。
	// 替换为--覆盖http后的标记：
	DownloadCmd: []string{"pull --overwrite"},

	TagCmd:         []tagCmd{{"tags", `^(\S+)`}},
	TagSyncCmd:     []string{"update -r {tag}"},
	TagSyncDefault: []string{"update -r revno:-1"},

	Scheme:      []string{"https", "http", "bzr", "bzr+ssh"},
	PingCmd:     "info -- {scheme}:// {repo}“，
	RemoteRepo:  bzrRemoteRepo,
	ResolveRepo: bzrResolveRepo,
}

func bzrRemoteRepo(vcsBzr *Cmd, rootDir string) (remoteRepo string, err error) {
	outb, err := vcsBzr.runOutput(rootDir, "config parent_location")
	if err != nil {
		return "", err
	}
	return strings.TrimSpace(string(outb)), nil
}

func bzrResolveRepo(vcsBzr *Cmd, rootDir, remoteRepo string) (realRepo string, err error) {
	outb, err := vcsBzr.runOutput(rootDir, "info "+remoteRepo)
	if err != nil {
		return "", err
	}
	out := string(outb)

	// 期望：
	// ...
	// （分支根|存储库分支）：<URL>
	// ...

	found := false
	for _, prefix := range []string{"\n  branch root: ", "\n  repository branch: "} {
		i := strings.Index(out, prefix)
		if i >= 0 {
			out = out[i+len(prefix):]
			found = true
			break
		}
	}
	if !found {
		return "", fmt.Errorf("unable to parse output of bzr info")
	}

	i := strings.Index(out, "\n")
	if i < 0 {
		return "", fmt.Errorf("unable to parse output of bzr info")
	}
	out = out[:i]
	return strings.TrimSpace(out), nil
}

// vcsSvn描述了如何使用Subversion。
var vcsSvn = &Cmd{
	Name: "Subversion",
	Cmd:  "svn",

	CreateCmd:   []string{"checkout -- {repo} {dir}"},
	DownloadCmd: []string{"update"},

	// subversion中没有标记命令。
	// 分支信息都在路径名中。

	Scheme:     []string{"https", "http", "svn", "svn+ssh"},
	PingCmd:    "info -- {scheme}:// {repo}“，
	RemoteRepo: svnRemoteRepo,
}

func svnRemoteRepo(vcsSvn *Cmd, rootDir string) (remoteRepo string, err error) {
	outb, err := vcsSvn.runOutput(rootDir, "info")
	if err != nil {
		return "", err
	}
	out := string(outb)

	// 期望：
	// None
	// ...
	// URL:<URL>
	// ...
	// None
	// 请注意，我们没有使用存储库根行，
	// 因为svn允许签出子树。
	// URL将是子树的URL（与“svn co”一起使用）
	// 而存储库根目录可能是更高的父目录。
	i := strings.Index(out, "\nURL: ")
	if i < 0 {
		return "", fmt.Errorf("unable to parse output of svn info")
	}
	out = out[i+len("\nURL: "):]
	i = strings.Index(out, "\n")
	if i < 0 {
		return "", fmt.Errorf("unable to parse output of svn info")
	}
	out = out[:i]
	return strings.TrimSpace(out), nil
}

// fossilRepoName是go get associates与化石存储库的名称。在
// 现实世界中，该文件可以命名为任何名称。
const fossilRepoName = ".fossil"

// vcsFossil描述了如何使用化石（化石scm.org）
var vcsFossil = &Cmd{
	Name: "Fossil",
	Cmd:  "fossil",

	CreateCmd:   []string{"-go-internal-mkdir {dir} clone -- {repo} " + filepath.Join("{dir}", fossilRepoName), "-go-internal-cd {dir} open .fossil"},
	DownloadCmd: []string{"up"},

	TagCmd:         []tagCmd{{"tag ls", `(.*)`}},
	TagSyncCmd:     []string{"up tag:{tag}"},
	TagSyncDefault: []string{"up trunk"},

	Scheme:     []string{"https", "http"},
	RemoteRepo: fossilRemoteRepo,
}

func fossilRemoteRepo(vcsFossil *Cmd, rootDir string) (remoteRepo string, err error) {
	out, err := vcsFossil.runOutput(rootDir, "remote-url")
	if err != nil {
		return "", err
	}
	return strings.TrimSpace(string(out)), nil
}

func (v *Cmd) String() string {
	return v.Name
}

// run在给定目录中运行命令行cmd。
// keyval是键、值对的列表。运行扩展
// cmd中{key}的实例转换为值，但仅在
// 将cmd拆分为单个参数。
// 如果发生错误，run将打印命令行和
// 命令的组合标准输出+标准错误。
// 否则，run将丢弃命令的输出。
func (v *Cmd) run(dir string, cmd string, keyval ...string) error {
	_, err := v.run1(dir, cmd, keyval, true)
	return err
}

// runVerboseOnly类似于run，但在详细模式下只生成标准错误的错误输出。
func (v *Cmd) runVerboseOnly(dir string, cmd string, keyval ...string) error {
	_, err := v.run1(dir, cmd, keyval, false)
	return err
}

// runOutput与run类似，但返回命令的输出。
func (v *Cmd) runOutput(dir string, cmd string, keyval ...string) ([]byte, error) {
	return v.run1(dir, cmd, keyval, true)
}

// run1是run和runOutput的通用实现。
func (v *Cmd) run1(dir string, cmdline string, keyval []string, verbose bool) ([]byte, error) {
	m := make(map[string]string)
	for i := 0; i < len(keyval); i += 2 {
		m[keyval[i]] = keyval[i+1]
	}
	args := strings.Fields(cmdline)
	for i, arg := range args {
		args[i] = expand(m, arg)
	}

	if len(args) >= 2 && args[0] == "-go-internal-mkdir" {
		var err error
		if filepath.IsAbs(args[1]) {
			err = os.Mkdir(args[1], fs.ModePerm)
		} else {
			err = os.Mkdir(filepath.Join(dir, args[1]), fs.ModePerm)
		}
		if err != nil {
			return nil, err
		}
		args = args[2:]
	}

	if len(args) >= 2 && args[0] == "-go-internal-cd" {
		if filepath.IsAbs(args[1]) {
			dir = args[1]
		} else {
			dir = filepath.Join(dir, args[1])
		}
		args = args[2:]
	}

	_, err := exec.LookPath(v.Cmd)
	if err != nil {
		fmt.Fprintf(os.Stderr,
			"go: missing %s command. See https:// golang.org/s/gogetcmd\n“，
			v.Name)
		return nil, err
	}

	cmd := exec.Command(v.Cmd, args...)
	cmd.Dir = dir
	cmd.Env = base.AppendPWD(os.Environ(), cmd.Dir)
	if cfg.BuildX {
		fmt.Fprintf(os.Stderr, "cd %s\n", dir)
		fmt.Fprintf(os.Stderr, "%s %s\n", v.Cmd, strings.Join(args, " "))
	}
	out, err := cmd.Output()
	if err != nil {
		if verbose || cfg.BuildV {
			fmt.Fprintf(os.Stderr, "# cd %s; %s %s\n", dir, v.Cmd, strings.Join(args, " "))
			if ee, ok := err.(*exec.ExitError); ok && len(ee.Stderr) > 0 {
				os.Stderr.Write(ee.Stderr)
			} else {
				fmt.Fprintf(os.Stderr, err.Error())
			}
		}
	}
	return out, err
}

// Ping pings以确定要使用的方案。
func (v *Cmd) Ping(scheme, repo string) error {
	return v.runVerboseOnly(".", v.PingCmd, "scheme", scheme, "repo", repo)
}

// Create在dir中创建一个新的repo副本。
// dir的父级必须存在；dir不能这样做。
func (v *Cmd) Create(dir, repo string) error {
	for _, cmd := range v.CreateCmd {
		if err := v.run(".", cmd, "dir", dir, "repo", repo); err != nil {
			return err
		}
	}
	return nil
}

// 下载目录中回购协议的任何新更改。
func (v *Cmd) Download(dir string) error {
	for _, cmd := range v.DownloadCmd {
		if err := v.run(dir, cmd); err != nil {
			return err
		}
	}
	return nil
}

// Tags返回目录中repo的可用标记列表。
func (v *Cmd) Tags(dir string) ([]string, error) {
	var tags []string
	for _, tc := range v.TagCmd {
		out, err := v.runOutput(dir, tc.cmd)
		if err != nil {
			return nil, err
		}
		re := regexp.MustCompile(`(?m-s)` + tc.pattern)
		for _, m := range re.FindAllStringSubmatch(string(out), -1) {
			tags = append(tags, m[1])
		}
	}
	return tags, nil
}

// tagSync将目录中的repo同步到命名标记，
// 它是由标记返回的标记，或者是v.tagDefault。
func (v *Cmd) TagSync(dir, tag string) error {
	if v.TagSyncCmd == nil {
		return nil
	}
	if tag != "" {
		for _, tc := range v.TagLookupCmd {
			out, err := v.runOutput(dir, tc.cmd, "tag", tag)
			if err != nil {
				return err
			}
			re := regexp.MustCompile(`(?m-s)` + tc.pattern)
			m := re.FindStringSubmatch(string(out))
			if len(m) > 1 {
				tag = m[1]
				break
			}
		}
	}

	if tag == "" && v.TagSyncDefault != nil {
		for _, cmd := range v.TagSyncDefault {
			if err := v.run(dir, cmd); err != nil {
				return err
			}
		}
		return nil
	}

	for _, cmd := range v.TagSyncCmd {
		if err := v.run(dir, cmd, "tag", tag); err != nil {
			return err
		}
	}
	return nil
}

// vcsPath描述了如何将导入路径转换为
// 版本控制系统和存储库名称。
type vcsPath struct {
	pathPrefix     string                              // 本说明适用于以下情况：
	regexp         *lazyregexp.Regexp                  // 导入路径的编译模式
	repo           string                              // 要使用的存储库（使用匹配的re进行扩展）
	vcs            string                              // 要使用的版本控制系统（随re的匹配而扩展）
	check          func(match map[string]string) error // 附加支票
	schemelessRepo bool                                // 如果为真，回购模式缺少一个方案
}

// FromDir检查dir及其父级以确定
// 要使用的版本控制系统和代码存储库。
// 返回时，root是导入路径
// 对应于存储库的根目录。
func FromDir(dir, srcRoot string) (vcs *Cmd, root string, err error) {
	// 清理并仔细检查dir是否位于srcRoot的（子目录）中。
	dir = filepath.Clean(dir)
	srcRoot = filepath.Clean(srcRoot)
	if len(dir) <= len(srcRoot) || dir[len(srcRoot)] != filepath.Separator {
		return nil, "", fmt.Errorf("directory %q is outside source root %q", dir, srcRoot)
	}

	var vcsRet *Cmd
	var rootRet string

	origDir := dir
	for len(dir) > len(srcRoot) {
		for _, vcs := range vcsList {
			if _, err := os.Stat(filepath.Join(dir, "."+vcs.Cmd)); err == nil {
				root := filepath.ToSlash(dir[len(srcRoot)+1:])
				// 记录我们找到的第一批风投，但继续寻找，
				// 检测错误，比如一种风投在另一种风投中。
				if vcsRet == nil {
					vcsRet = vcs
					rootRet = root
					continue
				}
				// Allow.git inside.git，它可能由于子模块而出现。
				if vcsRet == vcs && vcs.Cmd == "git" {
					continue
				}
				// 否则，我们在不同的VCS中有一个VCS。
				return nil, "", fmt.Errorf("directory %q uses %s, but parent %q uses %s",
					filepath.Join(srcRoot, rootRet), vcsRet.Cmd, filepath.Join(srcRoot, root), vcs.Cmd)
			}
		}

		// 移到父级。
		ndir := filepath.Dir(dir)
		if len(ndir) >= len(dir) {
			// 不应该发生，但以防万一，停下来。
			break
		}
		dir = ndir
	}

	if vcsRet != nil {
		if err := checkGOVCS(vcsRet, rootRet); err != nil {
			return nil, "", err
		}
		return vcsRet, rootRet, nil
	}

	return nil, "", fmt.Errorf("directory %q is not using a known version control system", origDir)
}

// govcsRule是一个单独的GOVCS规则，如private:hg | svn。
type govcsRule struct {
	pattern string
	allowed []string
}

// govcsConfig是完整的GOVCS配置。
type govcsConfig []govcsRule

func parseGOVCS(s string) (govcsConfig, error) {
	s = strings.TrimSpace(s)
	if s == "" {
		return nil, nil
	}
	var cfg govcsConfig
	have := make(map[string]string)
	for _, item := range strings.Split(s, ",") {
		item = strings.TrimSpace(item)
		if item == "" {
			return nil, fmt.Errorf("empty entry in GOVCS")
		}
		i := strings.Index(item, ":")
		if i < 0 {
			return nil, fmt.Errorf("malformed entry in GOVCS (missing colon): %q", item)
		}
		pattern, list := strings.TrimSpace(item[:i]), strings.TrimSpace(item[i+1:])
		if pattern == "" {
			return nil, fmt.Errorf("empty pattern in GOVCS: %q", item)
		}
		if list == "" {
			return nil, fmt.Errorf("empty VCS list in GOVCS: %q", item)
		}
		if search.IsRelativePath(pattern) {
			return nil, fmt.Errorf("relative pattern not allowed in GOVCS: %q", pattern)
		}
		if old := have[pattern]; old != "" {
			return nil, fmt.Errorf("unreachable pattern in GOVCS: %q after %q", item, old)
		}
		have[pattern] = item
		allowed := strings.Split(list, "|")
		for i, a := range allowed {
			a = strings.TrimSpace(a)
			if a == "" {
				return nil, fmt.Errorf("empty VCS name in GOVCS: %q", item)
			}
			allowed[i] = a
		}
		cfg = append(cfg, govcsRule{pattern, allowed})
	}
	return cfg, nil
}

func (c *govcsConfig) allow(path string, private bool, vcs string) bool {
	for _, rule := range *c {
		match := false
		switch rule.pattern {
		case "private":
			match = private
		case "public":
			match = !private
		default:
			// 注意：已知rule.pattern没有逗号，
			// 所以MatchPrefixPatterns只为我们匹配了一个模式。
			match = module.MatchPrefixPatterns(rule.pattern, path)
		}
		if !match {
			continue
		}
		for _, allow := range rule.allowed {
			if allow == vcs || allow == "all" {
				return true
			}
		}
		return false
	}

	// 默认情况下，不允许任何内容。
	return false
}

var (
	govcs     govcsConfig
	govcsErr  error
	govcsOnce sync.Once
)

// defaultGOVCS是GOVCS的默认设置。
// 设置GOVCS会在这些条目之前添加条目，但不会删除它们。
// （它们被附加到已解析的GOVCS设置中。）
// None
// 只允许Git和Mercurial的理由是
// 这两个系统是最受关注的问题
// 作为不受信任服务器的客户端运行。相反
// 集市、化石和颠覆主要被使用
// 在受信任的、经过身份验证的环境中，而不是
// 作为攻击面仔细检查。
// None
// 详情见golang.org/issue/41730。
var defaultGOVCS = govcsConfig{
	{"private", []string{"all"}},
	{"public", []string{"git", "hg"}},
}

func checkGOVCS(vcs *Cmd, root string) error {
	if vcs == vcsMod {
		// 直接模块（代理协议）取数不允许
		// 涉及外部版本控制系统
		// 而且总是被允许的。
		return nil
	}

	govcsOnce.Do(func() {
		govcs, govcsErr = parseGOVCS(os.Getenv("GOVCS"))
		govcs = append(govcs, defaultGOVCS...)
	})
	if govcsErr != nil {
		return govcsErr
	}

	private := module.MatchPrefixPatterns(cfg.GOPRIVATE, root)
	if !govcs.allow(root, private, vcs.Cmd) {
		what := "public"
		if private {
			what = "private"
		}
		return fmt.Errorf("GOVCS disallows using %s for %s %s; see 'go help vcs'", vcs.Cmd, what, root)
	}

	return nil
}

// CheckNested检查VCS内部是否存在嵌套不正确的VCS
// dir的情况，检查父级直到srcRoot。
func CheckNested(vcs *Cmd, dir, srcRoot string) error {
	if len(dir) <= len(srcRoot) || dir[len(srcRoot)] != filepath.Separator {
		return fmt.Errorf("directory %q is outside source root %q", dir, srcRoot)
	}

	otherDir := dir
	for len(otherDir) > len(srcRoot) {
		for _, otherVCS := range vcsList {
			if _, err := os.Stat(filepath.Join(otherDir, "."+otherVCS.Cmd)); err == nil {
				// 允许原始目录中的预期vcs。
				if otherDir == dir && otherVCS == vcs {
					continue
				}
				// Allow.git inside.git，它可能由于子模块而出现。
				if otherVCS == vcs && vcs.Cmd == "git" {
					continue
				}
				// 否则，我们在不同的VCS中有一个VCS。
				return fmt.Errorf("directory %q uses %s, but parent %q uses %s", dir, vcs.Cmd, otherDir, otherVCS.Cmd)
			}
		}
		// 移到父级。
		newDir := filepath.Dir(otherDir)
		if len(newDir) >= len(otherDir) {
			// 不应该发生，但以防万一，停下来。
			break
		}
		otherDir = newDir
	}

	return nil
}

// repoot描述源代码树的存储库根。
type RepoRoot struct {
	Repo     string // 存储库URL，包括方案
	Root     string // 对应于repo根目录的导入路径
	IsCustom bool   // 由服务的<meta>标记定义（与硬编码模式相反）
	VCS      *Cmd
}

func httpPrefix(s string) string {
	for _, prefix := range [...]string{"http:", "https:"} {
		if strings.HasPrefix(s, prefix) {
			return prefix
		}
	}
	return ""
}

// ModuleMode指定在查找代码源时是否首选模块。
type ModuleMode int

const (
	IgnoreMod ModuleMode = iota
	PreferMod
)

// ReprootForImportPath分析importPath以确定
// 版本控制系统和要使用的代码存储库。
func RepoRootForImportPath(importPath string, mod ModuleMode, security web.SecurityMode) (*RepoRoot, error) {
	rr, err := repoRootFromVCSPaths(importPath, security, vcsPaths)
	if err == errUnknownSite {
		rr, err = repoRootForImportDynamic(importPath, mod, security)
		if err != nil {
			err = importErrorf(importPath, "unrecognized import path %q: %v", importPath, err)
		}
	}
	if err != nil {
		rr1, err1 := repoRootFromVCSPaths(importPath, security, vcsPathsAfterDynamic)
		if err1 == nil {
			rr = rr1
			err = nil
		}
	}

	// 应该在上面处理，但要确保。
	if err == nil && strings.Contains(importPath, "...") && strings.Contains(rr.Root, "...") {
		// 不允许在repo根目录中使用通配符。
		rr = nil
		err = importErrorf(importPath, "cannot expand ... in %q", importPath)
	}
	return rr, err
}

var errUnknownSite = errors.New("dynamic lookup required to find mapping")

// repoRootFromVCSPaths尝试将importPath映射到repoRoot
// 使用vcsPaths中定义的映射。
func repoRootFromVCSPaths(importPath string, security web.SecurityMode, vcsPaths []*vcsPath) (*RepoRoot, error) {
	if str.HasPathPrefix(importPath, "example.net") {
		// TODO（rsc）：这应该不是必需的，但需要保持
		// 使用网络进行测试，如.././testdata/script/mod_get_extra.txt。
		// 该脚本在替换集中包含了它所需的所有内容，但它仍然是
		// 打网络电话。
		return nil, fmt.Errorf("no modules on example.net")
	}
	if importPath == "rsc.io" {
		// 此特殊情况允许进行.././testdata/script/govcs.txt等测试
		// 避免打任何网络电话。查找路径的模块
		// 像rsc.io/nonexist.svn/foo一样，不需要对
		// 在rsc.io上的查找。
		return nil, fmt.Errorf("rsc.io is not a module")
	}
	// 一个常见错误是使用https：
	// hg和git需要。对此进行有益的诊断。
	if prefix := httpPrefix(importPath); prefix != "" {
		// 导入路径已清理，因此只有一条斜线。模式
		// 忽略斜线；错误消息至少会将它们放回RHS。
		return nil, fmt.Errorf("%q not allowed in import path", prefix+"// ")
	}
	for _, srv := range vcsPaths {
		if !str.HasPathPrefix(importPath, srv.pathPrefix) {
			continue
		}
		m := srv.regexp.FindStringSubmatch(importPath)
		if m == nil {
			if srv.pathPrefix != "" {
				return nil, importErrorf(importPath, "invalid %s import path %q", srv.pathPrefix, importPath)
			}
			continue
		}

		// 为expand生成命名子表达式匹配项的生成映射。
		match := map[string]string{
			"prefix": srv.pathPrefix + "/",
			"import": importPath,
		}
		for i, name := range srv.regexp.SubexpNames() {
			if name != "" && match[name] == "" {
				match[name] = m[i]
			}
		}
		if srv.vcs != "" {
			match["vcs"] = expand(match, srv.vcs)
		}
		if srv.repo != "" {
			match["repo"] = expand(match, srv.repo)
		}
		if srv.check != nil {
			if err := srv.check(match); err != nil {
				return nil, err
			}
		}
		vcs := vcsByCmd(match["vcs"])
		if vcs == nil {
			return nil, fmt.Errorf("unknown version control system %q", match["vcs"])
		}
		if err := checkGOVCS(vcs, match["root"]); err != nil {
			return nil, err
		}
		var repoURL string
		if !srv.schemelessRepo {
			repoURL = match["repo"]
		} else {
			scheme := vcs.Scheme[0] // 默认为第一个方案
			repo := match["repo"]
			if vcs.PingCmd != "" {
				// 如果我们知道如何测试方案，请扫描以找到一个方案。
				for _, s := range vcs.Scheme {
					if security == web.SecureOnly && !vcs.isSecureScheme(s) {
						continue
					}
					if vcs.Ping(s, repo) == nil {
						scheme = s
						break
					}
				}
			}
			repoURL = scheme + ":// “+回购
		}
		rr := &RepoRoot{
			Repo: repoURL,
			Root: match["root"],
			VCS:  vcs,
		}
		return rr, nil
	}
	return nil, errUnknownSite
}

// urlForImportPath返回给定Go导入路径的部分填充URL。
// None
// URL将“方案”字段保留为空，以便web.Get将尝试任何方案
// 所选安全模式允许。
func urlForImportPath(importPath string) (*urlpkg.URL, error) {
	slash := strings.Index(importPath, "/")
	if slash < 0 {
		slash = len(importPath)
	}
	host, path := importPath[:slash], importPath[slash:]
	if !strings.Contains(host, ".") {
		return nil, errors.New("import path does not begin with hostname")
	}
	if len(path) == 0 {
		path = "/"
	}
	return &urlpkg.URL{Host: host, Path: path, RawQuery: "go-get=1"}, nil
}

// RepootForImportDynamic为非
// 静态地由reprootForImportPathStatic知道。
// None
// 这将处理自定义导入路径，如“name.tld/pkg/foo”或“name.tld”。
func repoRootForImportDynamic(importPath string, mod ModuleMode, security web.SecurityMode) (*RepoRoot, error) {
	url, err := urlForImportPath(importPath)
	if err != nil {
		return nil, err
	}
	resp, err := web.Get(security, url)
	if err != nil {
		msg := "https fetch: %v"
		if security == web.Insecure {
			msg = "http/" + msg
		}
		return nil, fmt.Errorf(msg, err)
	}
	body := resp.Body
	defer body.Close()
	imports, err := parseMetaGoImports(body, mod)
	if len(imports) == 0 {
		if respErr := resp.Err(); respErr != nil {
			// 如果服务器的状态不正常，则宁愿报告，而不是
			// XML分析错误。
			return nil, respErr
		}
	}
	if err != nil {
		return nil, fmt.Errorf("parsing %s: %v", importPath, err)
	}
	// 查找匹配的元导入。
	mmi, err := matchGoImport(imports, importPath)
	if err != nil {
		if _, ok := err.(ImportMismatchError); !ok {
			return nil, fmt.Errorf("parse %s: %v", url, err)
		}
		return nil, fmt.Errorf("parse %s: no go-import meta tags (%s)", resp.URL, err)
	}
	if cfg.BuildV {
		log.Printf("get %q: found meta tag %#v at %s", importPath, mmi, url)
	}
	// 如果导入为“uni.edu/bob/project”，则表示
	// 前缀为“uni.edu”，repoot为“evilroot.com”，
	// 确保我们不信任Bob，请访问evilroot.com
	// “uni.edu”（可能覆盖/抢占另一个）
	// 非邪恶学生）。相反，首先验证根目录并查看
	// 如果它符合鲍勃的要求。
	if mmi.Prefix != importPath {
		if cfg.BuildV {
			log.Printf("get %q: verifying non-authoritative meta tag", importPath)
		}
		var imports []metaImport
		url, imports, err = metaImportsForPrefix(mmi.Prefix, mod, security)
		if err != nil {
			return nil, err
		}
		metaImport2, err := matchGoImport(imports, importPath)
		if err != nil || mmi != metaImport2 {
			return nil, fmt.Errorf("%s and %s disagree about go-import for %s", resp.URL, url, mmi.Prefix)
		}
	}

	if err := validateRepoRoot(mmi.RepoRoot); err != nil {
		return nil, fmt.Errorf("%s: invalid repo root %q: %v", resp.URL, mmi.RepoRoot, err)
	}
	var vcs *Cmd
	if mmi.VCS == "mod" {
		vcs = vcsMod
	} else {
		vcs = vcsByCmd(mmi.VCS)
		if vcs == nil {
			return nil, fmt.Errorf("%s: unknown vcs %q", resp.URL, mmi.VCS)
		}
	}

	if err := checkGOVCS(vcs, mmi.Prefix); err != nil {
		return nil, err
	}

	rr := &RepoRoot{
		Repo:     mmi.RepoRoot,
		Root:     mmi.Prefix,
		IsCustom: true,
		VCS:      vcs,
	}
	return rr, nil
}

// 如果repoot看起来不正确，validateRepoot将返回一个错误
// 具有方案的有效URL。
func validateRepoRoot(repoRoot string) error {
	url, err := urlpkg.Parse(repoRoot)
	if err != nil {
		return err
	}
	if url.Scheme == "" {
		return errors.New("no scheme")
	}
	if url.Scheme == "file" {
		return errors.New("file scheme disallowed")
	}
	return nil
}

var fetchGroup singleflight.Group
var (
	fetchCacheMu sync.Mutex
	fetchCache   = map[string]fetchResult{} // 键是metaImportsForPrefix的importPrefix
)

// metaImportsForPrefix采用<meta>标记中声明的包的根导入路径
// 并返回其HTML发现URL和解析的元导入行
// 在页面上找到。
// None
// 导入路径的格式为“golang.org/x/tools”。
// 如果找不到导入，则为错误。
// 如果出现错误！=无
// 返回的url将采用“https:
func metaImportsForPrefix(importPrefix string, mod ModuleMode, security web.SecurityMode) (*urlpkg.URL, []metaImport, error) {
	setCache := func(res fetchResult) (fetchResult, error) {
		fetchCacheMu.Lock()
		defer fetchCacheMu.Unlock()
		fetchCache[importPrefix] = res
		return res, nil
	}

	resi, _, _ := fetchGroup.Do(importPrefix, func() (resi interface{}, err error) {
		fetchCacheMu.Lock()
		if res, ok := fetchCache[importPrefix]; ok {
			fetchCacheMu.Unlock()
			return res, nil
		}
		fetchCacheMu.Unlock()

		url, err := urlForImportPath(importPrefix)
		if err != nil {
			return setCache(fetchResult{err: err})
		}
		resp, err := web.Get(security, url)
		if err != nil {
			return setCache(fetchResult{url: url, err: fmt.Errorf("fetching %s: %v", importPrefix, err)})
		}
		body := resp.Body
		defer body.Close()
		imports, err := parseMetaGoImports(body, mod)
		if len(imports) == 0 {
			if respErr := resp.Err(); respErr != nil {
				// 如果服务器的状态不正常，则宁愿报告，而不是
				// XML分析错误。
				return setCache(fetchResult{url: url, err: respErr})
			}
		}
		if err != nil {
			return setCache(fetchResult{url: url, err: fmt.Errorf("parsing %s: %v", resp.URL, err)})
		}
		if len(imports) == 0 {
			err = fmt.Errorf("fetching %s: no go-import meta tag found in %s", importPrefix, resp.URL)
		}
		return setCache(fetchResult{url: url, imports: imports, err: err})
	})
	res := resi.(fetchResult)
	return res.url, res.imports, res.err
}

type fetchResult struct {
	url     *urlpkg.URL
	imports []metaImport
	err     error
}

// metaImport表示已解析的
// content=“prefix vcs repoot”/>HTML文件中的标记。
type metaImport struct {
	Prefix, VCS, RepoRoot string
}

// 如果存在元导入，则返回ImportMismatchError
// 但是没有一个匹配我们的导入路径。
type ImportMismatchError struct {
	importPath string
	mismatches []string // 因与我们的导入路径不匹配而丢弃的元导入
}

func (m ImportMismatchError) Error() string {
	formattedStrings := make([]string, len(m.mismatches))
	for i, pre := range m.mismatches {
		formattedStrings[i] = fmt.Sprintf("meta tag %s did not match import path %s", pre, m.importPath)
	}
	return strings.Join(formattedStrings, ", ")
}

// matchGoImport从与importPath匹配的导入中返回元导入。
// 如果存在多个匹配项，则返回错误。
// 如果没有匹配项，则返回ImportMismatchError。
func matchGoImport(imports []metaImport, importPath string) (metaImport, error) {
	match := -1

	errImportMismatch := ImportMismatchError{importPath: importPath}
	for i, im := range imports {
		if !str.HasPathPrefix(importPath, im.Prefix) {
			errImportMismatch.mismatches = append(errImportMismatch.mismatches, im.Prefix)
			continue
		}

		if match >= 0 {
			if imports[match].VCS == "mod" && im.VCS != "mod" {
				// 所有mod条目位于所有非mod条目之前。
				// 我们有一个mod条目，不关心其他条目，
				// 匹配与否。
				break
			}
			return metaImport{}, fmt.Errorf("multiple meta tags match import path %q", importPath)
		}
		match = i
	}

	if match == -1 {
		return metaImport{}, errImportMismatch
	}
	return imports[match], nil
}

// 展开“重写”，为匹配项中的每个键k将{k}替换为匹配项[k]。
func expand(match map[string]string, s string) string {
	// 我们想替换每一个匹配项一次，并且替换扩展的结果
	// 不能依赖于通过映射的迭代顺序。
	// 一个strings.Replacer正好具有我们要查找的属性。
	oldNew := make([]string, 0, 2*len(match))
	for k, v := range match {
		oldNew = append(oldNew, "{"+k+"}", v)
	}
	return strings.NewReplacer(oldNew...).Replace(s)
}

// vcsPaths定义了导入路径的含义
// 常用的VCS托管站点（github.com/user/dir）
// 以及引用完全限定的importPath的导入路径
// 包含VCS类型（foo.com/repo.git/dir）
var vcsPaths = []*vcsPath{
	// github
	{
		pathPrefix: "github.com",
		regexp:     lazyregexp.New(`^(?P<root>github\.com/[A-Za-z0-9_.\-]+/[A-Za-z0-9_.\-]+)(/[A-Za-z0-9_.\-]+)*$`),
		vcs:        "git",
		repo:       "https:// {root}“，
		check:      noVCSSuffix,
	},

	// 比特桶
	{
		pathPrefix: "bitbucket.org",
		regexp:     lazyregexp.New(`^(?P<root>bitbucket\.org/(?P<bitname>[A-Za-z0-9_.\-]+/[A-Za-z0-9_.\-]+))(/[A-Za-z0-9_.\-]+)*$`),
		repo:       "https:// {root}“，
		check:      bitbucketVCS,
	},

	// IBM DevOps服务（JazzHub）
	{
		pathPrefix: "hub.jazz.net/git",
		regexp:     lazyregexp.New(`^(?P<root>hub\.jazz\.net/git/[a-z0-9]+/[A-Za-z0-9_.\-]+)(/[A-Za-z0-9_.\-]+)*$`),
		vcs:        "git",
		repo:       "https:// {root}“，
		check:      noVCSSuffix,
	},

	// Apache上的Git
	{
		pathPrefix: "git.apache.org",
		regexp:     lazyregexp.New(`^(?P<root>git\.apache\.org/[a-z0-9_.\-]+\.git)(/[A-Za-z0-9_.\-]+)*$`),
		vcs:        "git",
		repo:       "https:// {root}“，
	},

	// OpenStack上的Git
	{
		pathPrefix: "git.openstack.org",
		regexp:     lazyregexp.New(`^(?P<root>git\.openstack\.org/[A-Za-z0-9_.\-]+/[A-Za-z0-9_.\-]+)(\.git)?(/[A-Za-z0-9_.\-]+)*$`),
		vcs:        "git",
		repo:       "https:// {root}“，
	},

	// fossil App.com
	{
		pathPrefix: "chiselapp.com",
		regexp:     lazyregexp.New(`^(?P<root>chiselapp\.com/user/[A-Za-z0-9]+/repository/[A-Za-z0-9_.\-]+)$`),
		vcs:        "fossil",
		repo:       "https:// {root}“，
	},

	// 任何服务器的通用语法。
	// 必须是最后一个。
	{
		regexp:         lazyregexp.New(`(?P<root>(?P<repo>([a-z0-9.\-]+\.)+[a-z0-9.\-]+(:[0-9]+)?(/~?[A-Za-z0-9_.\-]+)+?)\.(?P<vcs>bzr|fossil|git|hg|svn))(/~?[A-Za-z0-9_.\-]+)*$`),
		schemelessRepo: true,
	},
}

// VCSPAthAfterDynamic提供额外的vcsPaths条目
// 在动态HTML检查后重试。
// 这让这些网站有机会引入<meta>标签
// 作为远离硬编码逻辑的优雅过渡的一部分。
var vcsPathsAfterDynamic = []*vcsPath{
	// 发射台。见golang.org/issue/11436。
	{
		pathPrefix: "launchpad.net",
		regexp:     lazyregexp.New(`^(?P<root>launchpad\.net/((?P<project>[A-Za-z0-9_.\-]+)(?P<series>/[A-Za-z0-9_.\-]+)?|~[A-Za-z0-9_.\-]+/(\+junk|[A-Za-z0-9_.\-]+)/[A-Za-z0-9_.\-]+))(/[A-Za-z0-9_.\-]+)*$`),
		vcs:        "bzr",
		repo:       "https:// {root}“，
		check:      launchpadVCS,
	},
}

// noVCSSuffix检查存储库名称是否不存在
// 对于任何版本控制系统foo，以.foo结尾。
// 通常的罪魁祸首是“.git”。
func noVCSSuffix(match map[string]string) error {
	repo := match["repo"]
	for _, vcs := range vcsList {
		if strings.HasSuffix(repo, "."+vcs.Cmd) {
			return fmt.Errorf("invalid version control suffix in %s path", match["prefix"])
		}
	}
	return nil
}

// bitbucketVCS确定一个版本的版本控制系统
// Bitbucket存储库，通过使用Bitbucket API。
func bitbucketVCS(match map[string]string) error {
	if err := noVCSSuffix(match); err != nil {
		return err
	}

	var resp struct {
		SCM string `json:"scm"`
	}
	url := &urlpkg.URL{
		Scheme:   "https",
		Host:     "api.bitbucket.org",
		Path:     expand(match, "/2.0/repositories/{bitname}"),
		RawQuery: "fields=scm",
	}
	data, err := web.GetBytes(url)
	if err != nil {
		if httpErr, ok := err.(*web.HTTPError); ok && httpErr.StatusCode == 403 {
			// 这可能是一个私有存储库。如果是，请尝试确定
			// 它使用的VCS。见第5375期。
			root := match["root"]
			for _, vcs := range []string{"git", "hg"} {
				if vcsByCmd(vcs).Ping("https", root) == nil {
					resp.SCM = vcs
					break
				}
			}
		}

		if resp.SCM == "" {
			return err
		}
	} else {
		if err := json.Unmarshal(data, &resp); err != nil {
			return fmt.Errorf("decoding %s: %v", url, err)
		}
	}

	if vcsByCmd(resp.SCM) != nil {
		match["vcs"] = resp.SCM
		if resp.SCM == "git" {
			match["repo"] += ".git"
		}
		return nil
	}

	return fmt.Errorf("unable to detect version control system for bitbucket.org/ path")
}

// launchpadVCS解决了“lp.net/project/foo”的模糊性。在这种情况下,，
// “foo”可以是在Launchpad中注册的一个系列名称，它有自己的分支，
// 它也可以是主项目中的目录名
// 分支一级。
func launchpadVCS(match map[string]string) error {
	if match["project"] == "" || match["series"] == "" {
		return nil
	}
	url := &urlpkg.URL{
		Scheme: "https",
		Host:   "code.launchpad.net",
		Path:   expand(match, "/{project}{series}/.bzr/branch-format"),
	}
	_, err := web.GetBytes(url)
	if err != nil {
		match["root"] = expand(match, "launchpad.net/{project}")
		match["repo"] = expand(match, "https:// {root}”）
	}
	return nil
}

// importError是load.importError的副本，用于避免依赖循环
// 在cmd/go/internal/load上。它只需要满足load.ImportPartner。
type importError struct {
	importPath string
	err        error
}

func importErrorf(path, format string, args ...interface{}) error {
	err := &importError{importPath: path, err: fmt.Errorf(format, args...)}
	if errStr := err.Error(); !strings.Contains(errStr, path) {
		panic(fmt.Sprintf("path %q not in error %q", path, errStr))
	}
	return err
}

func (e *importError) Error() string {
	return e.err.Error()
}

func (e *importError) Unwrap() error {
	// 不要直接返回e.err，因为只有在%w
	// 已传递给Importerorf。
	return errors.Unwrap(e.err)
}

func (e *importError) ImportPath() string {
	return e.importPath
}
